Enhanced README: Contribution Guidelines, TOC, and Overview #2504
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ation guides, contribution guides, and TOC
MTRNord
requested changes
Sep 26, 2024
Comment on lines
+17
to
+19
| 1. ''' | ||
| git clone https://github.com/matrix-org/matrix.org.git | ||
| cd matrix.org |
There was a problem hiding this comment.
This seems to not be working with Github Markdown. Could you fix that please? Have a look at the rich diff button on the top right of this file to see how it is being rendered
Comment on lines
+31
to
+33
| ''' | ||
| zola build | ||
| ''' |
There was a problem hiding this comment.
Same as the other comment
Comment on lines
+39
to
+40
| ''' | ||
| git checkout -b <yourBranchName> |
There was a problem hiding this comment.
Same as the other comment
| 3. Create a new branch and implement changes using | ||
| ''' | ||
| git checkout -b <yourBranchName> | ||
| 4. Submit a pull request (PR) |
There was a problem hiding this comment.
Suggested change
| 4. Submit a pull request (PR) | |
| 4. Submit a pull request |
| # Contact Us | ||
|
|
||
| ## Community | ||
| If you have any questions about the project or your contribution, you may join the various community chats on https://matrix.to/#/#matrix.org-website:matrix.org |
There was a problem hiding this comment.
Suggested change
| If you have any questions about the project or your contribution, you may join the various community chats on https://matrix.to/#/#matrix.org-website:matrix.org | |
| If you have any questions about the project or your contribution, you may join our room https://matrix.to/#/#matrix.org-website:matrix.org |
| [#matrix.org-website:matrix.org](https://matrix.to/#/#matrix.org-website:matrix.org). | ||
| # Overview | ||
|
|
||
| Matrix.org is a decentralized, open standard for real-time communication which allows users to collaborate in public and private rooms over IP. Matrix's purpose is to allow users to text and call without thinking about what app or phone the other user has. |
There was a problem hiding this comment.
Suggested change
| Matrix.org is a decentralized, open standard for real-time communication which allows users to collaborate in public and private rooms over IP. Matrix's purpose is to allow users to text and call without thinking about what app or phone the other user has. | |
| Matrix.org is an open standard for decentralised, secure communications while also allowing you to bridge to other networks easily. | |
| This Repository covers our main website. | |
| For spec please take a look at https://github.com/matrix-org/matrix-spec | |
| For the conference website take a look at https://github.com/matrix-org/matrix-conf-website |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Descriptive Overview: Added a detailed intro about Matrix.org, emphasizing its purpose.
Build Instructions: Provided detailed step-by-step instructions for building the website
Table of Contents: Added a table of contents to make navigation through the various sections easier
Contribution Guidelines: Created a clear section for contribution and added steps for how to start contributing to this open-source project.